<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Compound Module <i>OverlayQuon</i></h2>
<b>Package:</b> oversim.overlay.quon<br/><b>File: <a href="src-overlay-quon-Quon.ned.html">src/overlay/quon/Quon.ned</a></b><br/><p>(no description)</p><img src="oversim.overlay.quon.OverlayQuon-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="oversim.overlay.quon.Quon.html" title="Quon" alt="Quon" coords="42,142,86,201">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram.
Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="oversim.overlay.quon.OverlayQuon-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="oversim.overlay.quon.OverlayQuon.html" title="Compound Module OverlayQuon" alt="" coords="60,6,159,34">
<area shape="rect" id="node2" href="ned.IdealChannel.html" title="Channel IdealChannel" alt="" coords="5,83,104,111">
<area shape="rect" id="node4" href="oversim.overlay.quon.Quon.html" title="Simple Module Quon" alt="" coords="128,83,200,111">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram.
Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="oversim.overlay.quon.OverlayQuon-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="oversim.overlay.quon.OverlayQuon.html" title="Compound Module OverlayQuon" alt="" coords="5,83,104,111">
<area shape="rect" id="node2" href="oversim.common.IOverlay.html" title="Module Interface IOverlay" alt="" coords="19,6,91,34">
</map>
<h3 class="subtitle">Gates:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Direction</th>
      <th>Size</th>
      <th>Description</th>
   </tr>
<tr class="local">
   <td width="150">udpIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate from the UDP layer</p>
</td>
</tr>
<tr class="local">
   <td width="150">udpOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>gate to the UDP layer</p>
</td>
</tr>
<tr class="local">
   <td width="150">tcpIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate from the TCP layer</p>
</td>
</tr>
<tr class="local">
   <td width="150">tcpOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>gate to the TCP layer</p>
</td>
</tr>
<tr class="local">
   <td width="150">appIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate from the application</p>
</td>
</tr>
<tr class="local">
   <td width="150">appOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>gate to the application</p>
</td>
</tr>
</table>
<h3 class="subtitle">Unassigned submodule parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.rpcUdpTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>default timeout value for direct RPCs</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.rpcKeyTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>default timeout value for routed RPCs</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.optimizeTimeouts</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>calculate timeouts from measured RTTs
and network coordinates</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.rpcExponentialBackoff</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, doubles the timeout for
every retransmission</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.localPort</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>UDP port for overlay messages</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.debugOutput</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>enable debug output</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.keyLength</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>overlay key length in bits</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.nodeId</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>optional nodeId as string in hexadecimal notation</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.useCommonAPIforward</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>enable CommonAPI forward() calls</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.drawOverlayTopology</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>draw arrow to successor node?</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.hopCountMax</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>maximum number of overlay hops</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.recNumRedundantNodes</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>numRedundantNodes for recursive routing</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.joinOnApplicationRequest</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>only join the overlay on application request</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.collectPerHopDelay</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>delay statistics for single hops</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.routeMsgAcks</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>use RPCs for route messages</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupRedundantNodes</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>number of next hops in each step</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupParallelPaths</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>number of parallel paths</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupParallelRpcs</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>number of nodes to ask in parallel</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupVerifySiblings</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>true, if siblings need to be authenticated with a ping</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupMajoritySiblings</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>true, if sibling candidates are selected by a majority decision if using parallel paths</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupMerge</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>true, if parallel Rpc results should be merged</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupFailedNodeRpcs</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>communicate failed nodes</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupStrictParallelRpcs</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>limited the number of concurrent rpcs to parameter parallelRpcs</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupUseAllParallelResponses</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>merge all parallel responses from earlier steps</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupNewRpcOnEveryTimeout</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>send a new RPC immediately after an RPC timeouts</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupNewRpcOnEveryResponse</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>send a new RPC after every response, even if there was no progress</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupFinishOnFirstUnchanged</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>finish lookup, if the last pending RPC returned without progress</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupVisitOnlyOnce</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, the same node is never asked twice during a single lookup</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.lookupAcceptLateSiblings</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, a <a href="FindNodeResponse.html">FindNodeResponse</a> with sibling flag set is always accepted, even if it is from a previous lookup step</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.routingType</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>default routing mode (iterative, semi-recursive,...)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.rejoinOnFailure</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>rejoin after loosing connection to the overlay?</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.sendRpcResponseToLastHop</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>needed by KBR protocols for NAT support</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.recordRoute</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>record visited hops on route</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.dropFindNodeAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it tries a findNode attack</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.isSiblingAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it tries a isSibling attack</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.invalidNodesAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it tries a invalidNode attack</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.dropRouteMessageAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it drops all received BaseRouteMessages</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.measureAuthBlock</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, measure the overhead of signatures in rpc messages</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.restoreContext</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, a node rejoins with its old nodeId and malicious state</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.areaDimension</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>movement range from [0.0, 0.0] to [areaDimension, areaDimension]</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.joinTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>retry join timeout in seconds</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.deleteTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>delete dead/offline neighbors from list of known neighbors after # seconds</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.aliveTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>ping neighbor status in seconds</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.contactBackupIntervall</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>contact backup neighbors every # seconds</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.numBackups</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>the number of binding beackups per quadrant</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.connectionLimit</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>maximum # of neighbor connections (for use with dynamic AOI)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.minAOIWidth</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>minimum area of interest size (for use with dynamic AOI)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.AOIWidth</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>this nodes area of interest (maximum area of interest when dynamic AOI is used)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.AOIBuffer</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>increase AOI by fixed amount</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.AOIAdaptionSensitivity</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>how much the AOI can be adapted in one step (for use with dynamic AOI) (max=1)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.AOIGossipSensitivity</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>how much the AOI adaption can be influenced by neighbors (for use with dynamic AOI) (max=1)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.AOIAdaptLinear</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>use linear AOI adaption? (for use with dynamic AOI)</p>
   </td>
</tr>
<tr>
   <td><a href="oversim.overlay.quon.Quon.html">quon</a>.useSquareMetric</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>use max(|a.x - b.x|, |a.y - b.y|) as distance metric instead of euclidean distance</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #800000; font-weight: bold; ">module</span><span style="color: #000000; "> </span><span style="color: #000000; ">OverlayQuon</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">like</span><span style="color: #000000; "> </span><span style="color: #000000; ">IOverlay</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">gates</span><span style="color: #000000; ">:
        </span><span style="color: #000080; font-weight: bold; ">input</span><span style="color: #000000; "> </span><span style="color: #000000; ">udpIn</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// gate from the UDP layer
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">output</span><span style="color: #000000; "> </span><span style="color: #000000; ">udpOut</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// gate to the UDP layer
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">input</span><span style="color: #000000; "> </span><span style="color: #000000; ">tcpIn</span><span style="color: #000000; ">;    </span><span style="color: #808080; font-style: italic; ">// gate from the TCP layer
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">output</span><span style="color: #000000; "> </span><span style="color: #000000; ">tcpOut</span><span style="color: #000000; ">;    </span><span style="color: #808080; font-style: italic; ">// gate to the TCP layer
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">input</span><span style="color: #000000; "> </span><span style="color: #000000; ">appIn</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// gate from the application
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">output</span><span style="color: #000000; "> </span><span style="color: #000000; ">appOut</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// gate to the application
</span><span style="color: #000000; ">
    </span><span style="color: #800000; font-weight: bold; ">submodules</span><span style="color: #000000; ">:
        </span><span style="color: #000000; ">quon</span><span style="color: #000000; ">: </span><span style="color: #000000; ">Quon</span><span style="color: #000000; "> {
            </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
                </span><span style="color: #000000; font-weight: bold; ">@display</span><span style="color: #000000; ">(</span><span style="color: #008000; ">&quot;p=60,60&quot;</span><span style="color: #000000; ">);

        }
    </span><span style="color: #800000; font-weight: bold; ">connections</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">allowunconnected</span><span style="color: #000000; ">:
        </span><span style="color: #000000; ">udpIn</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">--&gt;</span><span style="color: #000000; "> </span><span style="color: #000000; ">quon</span><span style="color: #000000; ">.</span><span style="color: #000000; ">udpIn</span><span style="color: #000000; ">;
        </span><span style="color: #000000; ">udpOut</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">&lt;--</span><span style="color: #000000; "> </span><span style="color: #000000; ">quon</span><span style="color: #000000; ">.</span><span style="color: #000000; ">udpOut</span><span style="color: #000000; ">;
        </span><span style="color: #000000; ">appIn</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">--&gt;</span><span style="color: #000000; "> </span><span style="color: #000000; ">quon</span><span style="color: #000000; ">.</span><span style="color: #000000; ">appIn</span><span style="color: #000000; ">;
        </span><span style="color: #000000; ">appOut</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">&lt;--</span><span style="color: #000000; "> </span><span style="color: #000000; ">quon</span><span style="color: #000000; ">.</span><span style="color: #000000; ">appOut</span><span style="color: #000000; ">;
}
</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
